Knowledge Base Generation

The Knowledge Base feature generates a parallel set of Markdown files that mirror your Reverb 2.0 output structure. This enables AI systems to access your documentation content in a format optimized for AI processing and retrieval.

Output Format

When enabled, ePublisher creates a knowledge base archive in the Output directory alongside the index.html entry-point file. By default a single project-wide archive is generated, named knowledge-<project-name>-<generation-hash>.zip, where <project-name> is your project name in lowercase with spaces replaced by hyphens, and <generation-hash> is an 8-character hash that changes each time you regenerate. The archive contains Markdown (.md) files that match the structure and filenames of the generated Reverb HTML pages.

File Structure

The folder structure and filenames within the Knowledge Base archive exactly match those of the Reverb 2.0 output. Each HTML page has a corresponding Markdown file with the same name but with a .md extension.

AI Integration

The Knowledge Base enables AI systems to align their knowledge with your published Reverb output. AI assistants can use these Markdown files to provide accurate, up-to-date answers based on your documentation.

Per-Parcel Archives

By default, ePublisher generates a single project-wide archive containing every parcel's Markdown files. When Generate Knowledge Base Per Parcel is enabled, ePublisher instead generates one archive per top-level group (parcel), named knowledge-parcel-<parcel-name>-<generation-hash>.zip, where <parcel-name> is the parcel name in lowercase with spaces replaced by hyphens. Each per-parcel archive contains only that parcel's Markdown files, which lets you update the knowledge base for a single parcel without re-uploading content for the entire project.

Knowledge Base Output Example

For a Reverb 2.0 output with the following structure:

Output/
├── index.html
├── knowledge-my-project-a1b2c3d4.zip
└── Getting Started/
    ├── introduction.html
    └── installation.html

The knowledge-my-project-a1b2c3d4.zip archive contains:

Getting Started/
├── introduction.md
└── installation.md

With Generate Knowledge Base Per Parcel enabled, the single project-wide archive is replaced by one archive per parcel (for example, knowledge-parcel-getting-started-a1b2c3d4.zip), each containing only that parcel's Markdown files.